Updated documents for new release by jonathanMLDev · Pull Request #236 · cppalliance/pinecone-read-only-mcp-typescript

jonathanMLDev · 2026-07-24T18:17:12Z

Summary:

1. CHANGELOG (`CHANGELOG.md`)

Added empty ## [Unreleased] stub; released content is ## [0.5.0] - 2026-07-25.
New bullets: Register suggest_query_params in core #223 (suggest_query_params in core), Wire request timeout and 429/5xx retry onto Pinecone I/O hot path #225 (timeout/retry on Pinecone I/O), Redact credentials at tool-error construction and in source_errors #234 (credential redaction), Harden retry/timeout classification on structured HTTP status and bra… #235 (structured retry/timeout classification).
Breaking-change migration links use 050-… anchors.
Footer: v0.5.0...HEAD and v0.4.0...v0.5.0.
0.3.0 trimmed-exports link updated to #050-trimmed-library-exports.

2. Version bump

package.json and package-lock.json (root + packages[""]) → 0.5.0.

3. MIGRATION anchors (`docs/MIGRATION.md`)

Retitled for this release:
- 0.5.0: list_sources response shape
- 0.5.0: PineconeClient.listNamespacesWithMetadata return shape
- 0.5.0: trimmed library exports
Left older “Unreleased” sections (e.g. stable vs experimental) unchanged per plan.

4. README & policy

README: Current version: 0.5.0, new Upgrading to 0.5.0 (breakings + facade note), all install/MCP/npx pins @0.5.0.
deprecation-policy.md: consumer pin example @0.5.0.

npm run docs:link-check passed, including new 050-… and README anchors.

Summary by CodeRabbit

New Features
- Added query-parameter suggestions.
- Added richer namespace metadata, including descriptions, schema sources, and configuration warnings.
- Expanded per-source and per-namespace configuration support.
Improvements
- Improved search reliability with configurable timeouts, retries, and backoff.
- Updated public response formats for source and namespace listings.
Bug Fixes
- Prevented sensitive Pinecone credentials from appearing in errors.
Documentation
- Published version 0.5.0 installation, upgrade, migration, and configuration guidance.

coderabbitai · 2026-07-24T18:17:39Z

Warning

Review limit reached

@jonathanMLDev, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 48 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dbdf0d6e-3686-4f34-bb3e-31b9549119f5

📥 Commits

Reviewing files that changed from the base of the PR and between 0c0b0c8 and b7a693a.

📒 Files selected for processing (3)

CHANGELOG.md
README.md
docs/MIGRATION.md

📝 Walkthrough

Walkthrough

The project version is bumped to 0.5.0, installation examples and upgrade guidance are updated, migration sections are marked released, and the changelog documents the release contents and comparison links.

Changes

0.5.0 Release

Layer / File(s)	Summary
Version and installation updates `package.json`, `README.md`	The package version and README installation, configuration, CLI, and deployment examples are updated from 0.4.0 to 0.5.0.
Migration and deprecation guidance `docs/MIGRATION.md`, `docs/deprecation-policy.md`	Migration sections are marked as released in 0.5.0, and version-pinning examples are updated accordingly.
Changelog release history `CHANGELOG.md`	The 0.5.0 release notes, migration anchors, historical link, and comparison links are updated.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

cppalliance/pinecone-read-only-mcp-typescript#122: Updates related migration, deprecation, README, and changelog documentation.

Suggested reviewers: wpak-ai, timon0305

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is related to the release docs update, but it is too vague to clearly identify the main change.	Use a more specific title such as "Update release documentation and version metadata for v0.5.0".

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

codecov · 2026-07-24T18:18:55Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@ea830a5). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #236   +/-   ##
=======================================
  Coverage        ?   86.34%           
=======================================
  Files           ?       48           
  Lines           ?     2599           
  Branches        ?      888           
=======================================
  Hits            ?     2244           
  Misses          ?      353           
  Partials        ?        2

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 69: Update the changelog entry for the removed experimental exports so
its release section and migration link both identify version 0.3.0: either move
the entry to the 0.5.0 section, or retain/create a corresponding 0.3.0 migration
anchor in MIGRATION.md.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2e5fd443-064e-4e15-b121-e556f71aa0c9

📥 Commits

Reviewing files that changed from the base of the PR and between ea830a5 and 0c0b0c8.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (5)

CHANGELOG.md
README.md
docs/MIGRATION.md
docs/deprecation-policy.md
package.json

Updated documents for new release

0c0b0c8

jonathanMLDev requested a review from wpak-ai as a code owner July 24, 2026 18:17

jonathanMLDev self-assigned this Jul 24, 2026

coderabbitai Bot reviewed Jul 24, 2026

View reviewed changes

Comment thread CHANGELOG.md Outdated

fixed 0.3.0's migration

b7a693a

jonathanMLDev merged commit c28e346 into cppalliance:main Jul 24, 2026
12 checks passed

jonathanMLDev deleted the chore/release-0.5.0 branch July 30, 2026 18:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Updated documents for new release - #236

Updated documents for new release#236
jonathanMLDev merged 2 commits into
cppalliance:mainfrom
jonathanMLDev:chore/release-0.5.0

jonathanMLDev commented Jul 24, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 24, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

❌ Failed checks (1 inconclusive)

Uh oh!

codecov Bot commented Jul 24, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

jonathanMLDev commented Jul 24, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary:

1. CHANGELOG (CHANGELOG.md)

2. Version bump

3. MIGRATION anchors (docs/MIGRATION.md)

4. README & policy

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

❌ Failed checks (1 inconclusive)

Uh oh!

codecov Bot commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jonathanMLDev commented Jul 24, 2026 •

edited by coderabbitai Bot

Loading

1. CHANGELOG (`CHANGELOG.md`)

3. MIGRATION anchors (`docs/MIGRATION.md`)

coderabbitai Bot commented Jul 24, 2026 •

edited

Loading

codecov Bot commented Jul 24, 2026 •

edited

Loading